<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /fasttmp/mkdist-qt-4.3.5-1211793125/qtopia-core-opensource-src-4.3.5/src/gui/styles/qstyleoption.cpp -->
<head>
  <title>Qt 4.3: QStyleOptionHeader Class Reference</title>
  <link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://www.trolltech.com/products/qt"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></a></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></table><h1 align="center">QStyleOptionHeader Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1>
<p>The QStyleOptionHeader class is used to describe the parameters for drawing a header. <a href="#details">More...</a></p>
<pre> #include &lt;QStyleOptionHeader&gt;</pre><p>Inherits <a href="qstyleoption.html">QStyleOption</a>.</p>
<ul>
<li><a href="qstyleoptionheader-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h3>Public Types</h3>
<ul>
<li><div class="fn"/>enum <b><a href="qstyleoptionheader.html#SectionPosition-enum">SectionPosition</a></b> { Beginning, Middle, End, OnlyOneSection }</li>
<li><div class="fn"/>enum <b><a href="qstyleoptionheader.html#SelectedPosition-enum">SelectedPosition</a></b> { NotAdjacent, NextIsSelected, PreviousIsSelected, NextAndPreviousAreSelected }</li>
<li><div class="fn"/>enum <b><a href="qstyleoptionheader.html#SortIndicator-enum">SortIndicator</a></b> { None, SortUp, SortDown }</li>
<li><div class="fn"/>enum <b><a href="qstyleoptionheader.html#StyleOptionType-enum">StyleOptionType</a></b> { Type }</li>
<li><div class="fn"/>enum <b><a href="qstyleoptionheader.html#StyleOptionVersion-enum">StyleOptionVersion</a></b> { Version }</li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"/><b><a href="qstyleoptionheader.html#QStyleOptionHeader">QStyleOptionHeader</a></b> ()</li>
<li><div class="fn"/><b><a href="qstyleoptionheader.html#QStyleOptionHeader-2">QStyleOptionHeader</a></b> ( const QStyleOptionHeader &amp; <i>other</i> )</li>
</ul>
<ul>
<li><div class="fn"/>2 public functions inherited from <a href="qstyleoption.html#public-functions">QStyleOption</a></li>
</ul>
<a name="public-variables"></a>
<h3>Public Variables</h3>
<ul>
<li><div class="fn"/>QIcon <b><a href="qstyleoptionheader.html#icon-var">icon</a></b></li>
<li><div class="fn"/>Qt::Alignment <b><a href="qstyleoptionheader.html#iconAlignment-var">iconAlignment</a></b></li>
<li><div class="fn"/>Qt::Orientation <b><a href="qstyleoptionheader.html#orientation-var">orientation</a></b></li>
<li><div class="fn"/>SectionPosition <b><a href="qstyleoptionheader.html#position-var">position</a></b></li>
<li><div class="fn"/>int <b><a href="qstyleoptionheader.html#section-var">section</a></b></li>
<li><div class="fn"/>SelectedPosition <b><a href="qstyleoptionheader.html#selectedPosition-var">selectedPosition</a></b></li>
<li><div class="fn"/>SortIndicator <b><a href="qstyleoptionheader.html#sortIndicator-var">sortIndicator</a></b></li>
<li><div class="fn"/>QString <b><a href="qstyleoptionheader.html#text-var">text</a></b></li>
<li><div class="fn"/>Qt::Alignment <b><a href="qstyleoptionheader.html#textAlignment-var">textAlignment</a></b></li>
</ul>
<ul>
<li><div class="fn"/>7 public variables inherited from <a href="qstyleoption.html#public-variables">QStyleOption</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QStyleOptionHeader class is used to describe the parameters for drawing a header.</p>
<p>QStyleOptionHeader contains all the information that <a href="qstyle.html">QStyle</a> functions need to draw the item views' header pane, header sort arrow, and header label.</p>
<p>For performance reasons, the access to the member variables is direct (i.e&#x2e;, using the <tt>.</tt> or <tt>-&gt;</tt> operator). This low-level feel makes the structures straightforward to use and emphasizes that these are simply parameters used by the style functions.</p>
<p>For an example demonstrating how style options can be used, see the <a href="widgets-styles.html">Styles</a> example.</p>
<p>See also <a href="qstyleoption.html">QStyleOption</a>.</p>
<hr />
<h2>Member Type Documentation</h2>
<h3 class="fn"><a name="SectionPosition-enum"></a>enum QStyleOptionHeader::SectionPosition</h3>
<p>This enum lets you know where the section's position is in relation to the other sections.</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::Beginning</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">At the beginining of the header</td></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::Middle</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">In the middle of the header</td></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::End</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">At the end of the header</td></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::OnlyOneSection</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">Only one header section</td></tr>
</table></p>
<p>See also <a href="qstyleoptionheader.html#position-var">position</a>.</p>
<h3 class="fn"><a name="SelectedPosition-enum"></a>enum QStyleOptionHeader::SelectedPosition</h3>
<p>This enum lets you know where the section's position is in relation to the selected section.</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::NotAdjacent</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">Not adjacent to the selected section</td></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::NextIsSelected</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">The next section is selected</td></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::PreviousIsSelected</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">The previous section is selected</td></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::NextAndPreviousAreSelected</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">Both the next and previous section are selected</td></tr>
</table></p>
<p>See also <a href="qstyleoptionheader.html#selectedPosition-var">selectedPosition</a>.</p>
<h3 class="fn"><a name="SortIndicator-enum"></a>enum QStyleOptionHeader::SortIndicator</h3>
<p>Indicates which direction the sort indicator should be drawn</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::None</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">No sort indicator is needed</td></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::SortUp</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">Draw an up indicator</td></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::SortDown</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">Draw a down indicator</td></tr>
</table></p>
<p>See also <a href="qstyleoptionheader.html#sortIndicator-var">sortIndicator</a>.</p>
<h3 class="fn"><a name="StyleOptionType-enum"></a>enum QStyleOptionHeader::StyleOptionType</h3>
<p>This enum is used to hold information about the type of the style option, and is defined for each <a href="qstyleoption.html">QStyleOption</a> subclass.</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::Type</tt></td><td align="center" valign="top"><tt>SO_Header</tt></td><td valign="top">The type of style option provided (<a href="qstyleoption.html#OptionType-enum">SO_Header</a> for this class).</td></tr>
</table></p>
<p>The type is used internally by <a href="qstyleoption.html">QStyleOption</a>, its subclasses, and <a href="qstyleoption.html#qstyleoption_cast">qstyleoption_cast</a>() to determine the type of style option. In general you do not need to worry about this unless you want to create your own <a href="qstyleoption.html">QStyleOption</a> subclass and your own styles.</p>
<p>See also <a href="qstyleoptionheader.html#StyleOptionVersion-enum">StyleOptionVersion</a>.</p>
<h3 class="fn"><a name="StyleOptionVersion-enum"></a>enum QStyleOptionHeader::StyleOptionVersion</h3>
<p>This enum is used to hold information about the version of the style option, and is defined for each <a href="qstyleoption.html">QStyleOption</a> subclass.</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QStyleOptionHeader::Version</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">1</td></tr>
</table></p>
<p>The version is used by <a href="qstyleoption.html">QStyleOption</a> subclasses to implement extensions without breaking compatibility. If you use <a href="qstyleoption.html#qstyleoption_cast">qstyleoption_cast</a>(), you normally don't need to check it.</p>
<p>See also <a href="qstyleoptionheader.html#StyleOptionType-enum">StyleOptionType</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QStyleOptionHeader"></a>QStyleOptionHeader::QStyleOptionHeader ()</h3>
<p>Constructs a <a href="qstyleoptionheader.html">QStyleOptionHeader</a>, initializing the members variables to their default values.</p>
<h3 class="fn"><a name="QStyleOptionHeader-2"></a>QStyleOptionHeader::QStyleOptionHeader ( const QStyleOptionHeader &amp; <i>other</i> )</h3>
<p>Constructs a copy of the <i>other</i> style option.</p>
<hr />
<h2>Member Variable Documentation</h2>
<h3 class="fn"><a name="icon-var"></a><a href="qicon.html">QIcon</a> QStyleOptionHeader::icon</h3>
<p>This variable holds the icon of the header.</p>
<p>The default value is an empty icon, i.e&#x2e; an icon with neither a pixmap nor a filename.</p>
<h3 class="fn"><a name="iconAlignment-var"></a><a href="qt.html#AlignmentFlag-enum">Qt::Alignment</a> QStyleOptionHeader::iconAlignment</h3>
<p>This variable holds the alignment flags for the icon of the header.</p>
<p>The default value is <a href="qt.html#AlignmentFlag-enum">Qt::AlignLeft</a>.</p>
<h3 class="fn"><a name="orientation-var"></a><a href="qt.html#Orientation-enum">Qt::Orientation</a> QStyleOptionHeader::orientation</h3>
<p>This variable holds the header's orientation (horizontal or vertical).</p>
<p>The default orientation is <a href="qt.html#Orientation-enum">Qt::Horizontal</a></p>
<h3 class="fn"><a name="position-var"></a><a href="qstyleoptionheader.html#SectionPosition-enum">SectionPosition</a> QStyleOptionHeader::position</h3>
<p>This variable holds the section's position in relation to the other sections.</p>
<p>The default value is <a href="qstyleoptionheader.html#SectionPosition-enum">QStyleOptionHeader::Beginning</a>.</p>
<h3 class="fn"><a name="section-var"></a>int QStyleOptionHeader::section</h3>
<p>This variable holds which section of the header is being painted.</p>
<p>The default value is 0.</p>
<h3 class="fn"><a name="selectedPosition-var"></a><a href="qstyleoptionheader.html#SelectedPosition-enum">SelectedPosition</a> QStyleOptionHeader::selectedPosition</h3>
<p>This variable holds the section's position in relation to the selected section.</p>
<p>The default value is <a href="qstyleoptionheader.html#SelectedPosition-enum">QStyleOptionHeader::NotAdjacent</a></p>
<h3 class="fn"><a name="sortIndicator-var"></a><a href="qstyleoptionheader.html#SortIndicator-enum">SortIndicator</a> QStyleOptionHeader::sortIndicator</h3>
<p>This variable holds the direction the sort indicator should be drawn.</p>
<p>The default value is <a href="qstyleoptionheader.html#SortIndicator-enum">QStyleOptionHeader::None</a>.</p>
<h3 class="fn"><a name="text-var"></a><a href="qstring.html">QString</a> QStyleOptionHeader::text</h3>
<p>This variable holds the text of the header.</p>
<p>The default value is an empty string.</p>
<h3 class="fn"><a name="textAlignment-var"></a><a href="qt.html#AlignmentFlag-enum">Qt::Alignment</a> QStyleOptionHeader::textAlignment</h3>
<p>This variable holds the alignment flags for the text of the header.</p>
<p>The default value is <a href="qt.html#AlignmentFlag-enum">Qt::AlignLeft</a>.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright &copy; 2008 <a href="trolltech.html">Trolltech</a></td>
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt 4.3.5</div></td>
</tr></table></div></address></body>
</html>
